Skip to content

Rename defineFirestate to createFirestate#14

Merged
TrystonPerry merged 1 commit into
masterfrom
claude/affectionate-bohr-7WpXn
Jun 5, 2026
Merged

Rename defineFirestate to createFirestate#14
TrystonPerry merged 1 commit into
masterfrom
claude/affectionate-bohr-7WpXn

Conversation

@TrystonPerry

Copy link
Copy Markdown
Collaborator

Summary

Rename the primary registry API function from defineFirestate to createFirestate for better semantic clarity. The new name better reflects that the function creates and returns typed React hooks rather than defining a static schema.

Changes

  • Renamed defineFirestate function to createFirestate throughout the codebase
  • Updated all imports, exports, and references in:
    • Source code (src/firestate.ts, src/index.ts)
    • Tests (src/firestate.test.ts)
    • Documentation (README.md, AGENTS.md, docs/api-recipes.md, docs/architecture.md, CONTRIBUTING.md)
    • Examples (examples/react-tasks/src/schemas.ts, examples/react-tasks/src/App.tsx)
    • Internal references in JSDoc comments (src/schema.ts)

Implementation Details

  • The function signature and behavior remain unchanged; this is purely a naming update
  • All generated hook names (e.g., useTaskList, useTasks) remain the same
  • The registry-based API continues to work identically, just with the clearer function name
  • Updated all documentation examples to use the new name consistently

https://claude.ai/code/session_01VRSXNBSHMuJ7aFPx9GHWYx

Rename the registry API entry point across source, tests, the runnable
example, and all documentation. The lower-level defineDocument /
defineCollection escape hatch is unchanged.

https://claude.ai/code/session_01VRSXNBSHMuJ7aFPx9GHWYx
@TrystonPerry TrystonPerry merged commit ea27449 into master Jun 5, 2026
1 check passed
@TrystonPerry TrystonPerry deleted the claude/affectionate-bohr-7WpXn branch June 5, 2026 22:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants